Change SumoBot to deleted_user (#6537)

* Change SumoBot to deleted user
* In messaging, when a user who received a message is deleted
the sending users outbox will now show the message was to
deleted user
* When a message in your inbox is from a user who is deleted
it will appear as being from deleted user

* Extract user check to be DRY

Author: smithellis

kitsune/messages/handlers.py

@@ -13,8 +13,16 @@ def on_user_deletion(self, user: User) -> None:
         When a user is deleted:
         - Delete their outbox messages
         - Keep inbox messages for other users and reassign them to SumoBot
+        - Update outbox message recipients to SumoBot where the deleted user was a recipient
         """
         sumo_bot = Profile.get_sumo_bot()
         InboxMessage.objects.filter(to=user).delete()
         InboxMessage.objects.filter(sender=user).update(sender=sumo_bot)
+
+        # Update outbox messages where the deleted user was a recipient
+        outbox_messages = OutboxMessage.objects.filter(to=user)
+        for message in outbox_messages:
+            message.to.remove(user)
+            message.to.add(sumo_bot)
+
         OutboxMessage.objects.filter(sender=user).delete()

kitsune/messages/jinja2/messages/inbox.html

@@ -1,5 +1,5 @@
 {% extends "messages/base.html" %}
-{% from "messages/includes/macros.html" import avatar_link, name_link %}
+{% from "messages/includes/macros.html" import avatar_link, display_user %}
 {% set title = _('Inbox') %}
 {% set crumbs = [(url('messages.inbox'), _('Messages')),
                  (None, title)] %}
@@ -37,7 +37,7 @@ <h1 class="sumo-page-heading">{{ title }}</h1>
                     {{ avatar_link(message.sender, default_avatar) }}
                 </div>
                 <div class="email-cell from">
-                    {{ name_link(message.sender) }}
+                    {{ display_user(message.sender) }}
                 </div>
                 <div class="email-cell date">
                     {{ datetimeformat(message.created) }}

kitsune/messages/jinja2/messages/includes/macros.html

@@ -1,5 +1,13 @@
 {% from "includes/common_macros.html" import content_editor with context %}
 
+{% macro display_user(user) -%}
+  {% if user.profile.is_system_account %}
+    {{ _('deleted user') }}
+  {% else %}
+    {{ name_link(user) }}
+  {% endif %}
+{%- endmacro %}
+
 {% macro avatar_link(user=None, default_avatar=None) -%}
   {% if user %}
     <a rel="nofollow" href="{{ profile_url(user) }}">
@@ -42,7 +50,7 @@
       {{ avatar_link(message.sender, default_avatar) }}
     </div>
     <div class="user from">
-      {{ name_link(message.sender) }} {{ datetimeformat(message.created) }}
+      {{ display_user(message.sender) }} {{ datetimeformat(message.created) }}
     </div>
   </div>
 </section>
@@ -55,11 +63,11 @@
   {% if message.recipients_count > 0 %}
     <p><strong>{{ _('To') }}:</strong>
     {% set comma = joiner(', ') %}
-    {% for user in message.to.all() -%}
+    {% for user in message.to_users -%}
         {{ comma() }}
-        {{ name_link(user) }}
+        {{ display_user(user) }}
     {% else %}
-      {{ name_link(message.recipient) }}
+      {{ display_user(message.recipient) }}
     {% endfor %}
     </p>
   {% endif %}

kitsune/messages/jinja2/messages/outbox.html

@@ -1,5 +1,5 @@
 {% extends "messages/base.html" %}
-{% from "messages/includes/macros.html" import avatar_link, name_link %}
+{% from "messages/includes/macros.html" import avatar_link, display_user %}
 {% set title = _('Sent Messages') %}
 {% set crumbs = [(url('messages.inbox'), _('Messages')),
                  (None, title)] %}
@@ -38,9 +38,7 @@ <h1 class="sumo-page-heading">{{ title }}</h1>
                 <div class="email-cell sent">{{ datetimeformat(message.created) }}</div>
                 <div class="email-cell to">
                 {% for user in message.to.all()[:1] -%}
-                    <a rel="nofollow" href="{{ profile_url(user) }}">
-                        {{ user.profile.display_name }}
-                    </a>
+                    {{ display_user(user) }}
                     {%- if message.recipients_count > 1 -%}, ...{% endif %}
                 {%- endfor %}
                 </div>

kitsune/messages/views.py

@@ -26,7 +26,6 @@ def inbox(request):
         .prefetch_related("sender__profile")
     )
     count = messages.count()
-
     messages = paginate(request, messages, per_page=MESSAGES_PER_PAGE, count=count)
 
     return render(
@@ -42,19 +41,25 @@ def read(request, msgid):
     was_new = message.unread
     if was_new:
         message.update(read=True)
+
     initial = {"to": message.sender, "in_reply_to": message.pk}
     form = ReplyForm(initial=initial)
     response = render(
         request,
         "messages/read.html",
-        {"message": message, "form": form, "default_avatar": settings.DEFAULT_AVATAR},
+        {
+            "message": message,
+            "form": form,
+            "default_avatar": settings.DEFAULT_AVATAR,
+        },
     )
     return response
 
 
 @login_required
 def read_outbox(request, msgid):
     message = get_object_or_404(OutboxMessage, pk=msgid, sender=request.user)
+
     return render(
         request,
         "messages/read-outbox.html",
@@ -179,6 +184,26 @@ def preview_async(request):
 
 
 def _add_recipients(msg):
+    """Process and attach recipient information to a message object.
+
+    This helper function calculates recipient counts and attaches recipient-related
+    attributes to the message object for display purposes.
+
+    Args:
+        msg: An OutboxMessage object to process.
+
+    Returns:
+        The modified message object with the following attributes set:
+            - recipients_count: Total number of individual recipients
+            - to_groups_count: Total number of group recipients
+            - recipient: The first recipient if there is exactly one
+            individual recipient, else None
+            - to_groups: List of recipient groups with prefetched profiles
+
+    Note:
+        The function expects msg.to and msg.to_group to be prefetched related fields
+        on the OutboxMessage object.
+    """
     # Set the counts based on the lists
     msg.recipients_count = msg.to.all().count()
     msg.to_groups_count = msg.to_group.all().count()